<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <base data-ice="baseUrl" href="../">
  <title data-ice="title">Manual | live2d-widget.js</title>
  <link type="text/css" rel="stylesheet" href="css/style.css">
  <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
  <script src="script/prettify/prettify.js"></script>
  <script src="script/manual.js"></script>
<meta name="description" content="Add the Sseexxyyy live2d to webpages."><meta property="twitter:card" content="summary"><meta property="twitter:title" content="live2d-widget.js"><meta property="twitter:description" content="Add the Sseexxyyy live2d to webpages."></head>
<body class="layout-container manual-root" data-ice="rootContainer">

<header>
  <a href="./">Home</a>
  
  <a href="identifiers.html">Reference</a>
  <a href="source.html">Source</a>
  
  <div class="search-box">
  <span>
    <img src="./image/search.png">
    <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
  </span>
    <ul class="search-result"></ul>
  </div>
<a style="position:relative; top:3px;" href="https://github.com/xiazeyu/live2d-widget.js"><img width="20px" src="./image/github.png"></a></header>

<nav class="navigation" data-ice="nav"><div class="manual-toc-root">
  
<div data-ice="manual">
    <ul class="manual-toc">
      
    <li data-ice="manualNav" class="indent-h1" data-link="manual/README.html"><a href="manual/README.html" data-ice="link">live2d-widget.js</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#useage" data-ice="link">Useage</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#hexo" data-ice="link">Hexo</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#webpages" data-ice="link">Webpages</a></li>
<li data-ice="manualNav" class="indent-h4" data-link="manual/README.html"><a href="manual/README.html#file-on-your-server" data-ice="link">File on your server</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#bookmark--any-pages-" data-ice="link">Bookmark (any pages)</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#settings" data-ice="link">Settings</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#custom-model" data-ice="link">Custom model</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#contribute" data-ice="link">Contribute</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#releated-projects" data-ice="link">Releated projects</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#about-me" data-ice="link">About me</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#imported" data-ice="link">Imported</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#special-thanks" data-ice="link">Special Thanks</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#contributors" data-ice="link">Contributors</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#backers" data-ice="link">Backers</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#sponsors" data-ice="link">Sponsors</a></li>
</ul>
  </div>
<div data-ice="manual">
    <ul class="manual-toc">
      
    <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#-lt-small-gt-3-0-6--2019-04-01--lt--small-gt-" data-ice="link">&lt;small&gt;3.0.6 (2019-04-01)&lt;/small&gt;</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#-lt-small-gt-3-0-5--2018-02-15--lt--small-gt-" data-ice="link">&lt;small&gt;3.0.5 (2018-02-15)&lt;/small&gt;</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#-lt-small-gt-3-0-4--2018-02-07--lt--small-gt-" data-ice="link">&lt;small&gt;3.0.4 (2018-02-07)&lt;/small&gt;</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#-lt-small-gt-3-0-2--2018-01-20--lt--small-gt-" data-ice="link">&lt;small&gt;3.0.2 (2018-01-20)&lt;/small&gt;</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#-lt-small-gt-3-0-1--2018-01-19--lt--small-gt-" data-ice="link">&lt;small&gt;3.0.1 (2018-01-19)&lt;/small&gt;</a></li>
<li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#3-0-0--2018-01-13-" data-ice="link">3.0.0 (2018-01-13)</a></li>
<li data-ice="manualNav" class="indent-h3" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#breaking-change" data-ice="link">BREAKING CHANGE</a></li>
</ul>
  </div>
</div>
</nav>

<div class="content" data-ice="content"><div class="github-markdown" data-ice="content"><h2 id="-lt-small-gt-3-0-6--2019-04-01--lt--small-gt-">&lt;small&gt;3.0.6 (2019-04-01)&lt;/small&gt;</h2><ul>
<li>Added backers and sponsors on the README (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/f4f28a5">f4f28a5</a>)</li>
<li>Added call to donate after npm install (optional) (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/c2de585">c2de585</a>)</li>
<li>Update Docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/4684581">4684581</a>)</li>
<li>update ghpages submodule (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/c04026d">c04026d</a>)</li>
<li>Update issue templates (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/59747f7">59747f7</a>)</li>
<li>Update issue templates (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/9ea3e92">9ea3e92</a>)</li>
<li>Update Readme (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/32423c3">32423c3</a>)</li>
<li>fix: model motion (.mtn) cache (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/a337ff7">a337ff7</a>), closes <a href="https://github.com/xiazeyu/live2d-widget.js/issues/4">#4</a></li>
<li>fix: tap area error (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/d929f60">d929f60</a>)</li>
<li>refactor: remove lodash (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/fe17c5a">fe17c5a</a>)</li>
<li>docs: update submodule (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/c47dcac">c47dcac</a>)</li>
<li>docs: update submodule, fix errors (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/892fdbe">892fdbe</a>)</li>
<li>docs: update template (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/34fde16">34fde16</a>)</li>
<li>ci: auto add title on CHANGELOG.md (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/b8e187d">b8e187d</a>)</li>
<li>ci: encrypt new ssh key (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/5e49a05">5e49a05</a>)</li>
<li>ci: fix error (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/357391e">357391e</a>)</li>
<li>ci: fix error (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7f504ef">7f504ef</a>)</li>
<li>ci: fix typo (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/b41562f">b41562f</a>)</li>
<li>build: greater build flow (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/4a99b1c">4a99b1c</a>)</li>
</ul>
<h2 id="-lt-small-gt-3-0-5--2018-02-15--lt--small-gt-">&lt;small&gt;3.0.5 (2018-02-15)&lt;/small&gt;</h2><ul>
<li>chore: bump version, upload production lib (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/d321872">d321872</a>)</li>
<li>ci: add support for Travis (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/b575b69">b575b69</a>)</li>
<li>ci: config travis (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/870f27a">870f27a</a>)</li>
<li>ci: fix config error (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/dc2ebd5">dc2ebd5</a>)</li>
<li>ci: fix config errors (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7c9b867">7c9b867</a>)</li>
<li>ci: fix errors (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/43d8a10">43d8a10</a>)</li>
<li>ci: fix travis bug (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/99f392f">99f392f</a>)</li>
<li>ci: modify npm script &apos;build:esdoc&apos; for linux-only-use (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/f8905f9">f8905f9</a>)</li>
<li>ci: remove encrypt, since this is only used to access ghpage (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/e2cf234">e2cf234</a>)</li>
<li>ci: travis bugs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/1d3db7b">1d3db7b</a>)</li>
<li>ci: travis errors (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/6aefd13">6aefd13</a>)</li>
<li>ci: try...to...fix... travis error (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0e9c1b5">0e9c1b5</a>)</li>
<li>style: add eslint (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/9080413">9080413</a>)</li>
<li>style: npm script style (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0ef7538">0ef7538</a>)</li>
<li>build: update CHANGELOG build flow (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/17de15a">17de15a</a>)</li>
<li>docs: add git module of ghpages (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/8492034">8492034</a>)</li>
<li>docs: ghpages (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/103b1dc">103b1dc</a>)</li>
<li>docs: update build:docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/9b1ce55">9b1ce55</a>)</li>
<li>docs: use submodule to store docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0e25ac7">0e25ac7</a>)</li>
</ul>
<h2 id="-lt-small-gt-3-0-4--2018-02-07--lt--small-gt-">&lt;small&gt;3.0.4 (2018-02-07)&lt;/small&gt;</h2><ul>
<li>docs: migrate documents to live2d-widget.js-doc (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/90b9894">90b9894</a>)</li>
<li>docs: update CHANGELOG (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/9ae492e">9ae492e</a>)</li>
<li>3.0.4 (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/d71c60b">d71c60b</a>)</li>
<li>build: remove lib from github, rename output file (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/efc0f53">efc0f53</a>)</li>
<li>build(entry): add entry point in package.json (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/b7240fb">b7240fb</a>)</li>
</ul>
<h2 id="-lt-small-gt-3-0-2--2018-01-20--lt--small-gt-">&lt;small&gt;3.0.2 (2018-01-20)&lt;/small&gt;</h2><ul>
<li>3.0.2 (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/1bd3909">1bd3909</a>)</li>
<li>docs(update doc): (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/423465f">423465f</a>)</li>
<li>feat: seperate defaultConfig for supporting helper (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/5fa4587">5fa4587</a>)</li>
</ul>
<h2 id="-lt-small-gt-3-0-1--2018-01-19--lt--small-gt-">&lt;small&gt;3.0.1 (2018-01-19)&lt;/small&gt;</h2><ul>
<li>docs: relink js to unpkg CDN (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0bd9cdf">0bd9cdf</a>)</li>
<li>docs: update CHANGELOG (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/c840cfa">c840cfa</a>)</li>
<li>docs: update docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/188368a">188368a</a>)</li>
<li>docs(method of execute): finish the doc of launch it (use var) (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/1b43dc0">1b43dc0</a>)</li>
<li>feat: new build (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/f70a36c">f70a36c</a>)</li>
<li>fix: achieve frameshot, recover event system (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/aed9c26">aed9c26</a>)</li>
<li>style: change L2Dwidget into Class (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/59909df">59909df</a>)</li>
<li>build(add script to bump version better): (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/a2d04e8">a2d04e8</a>)</li>
<li>build(fix changelog script path problem): (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/67c56ee">67c56ee</a>)</li>
<li>chore(update dependency settings): (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7796aac">7796aac</a>)</li>
<li>build: remove ghpages from npm publish (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7401ffe">7401ffe</a>)</li>
</ul>
<h2 id="3-0-0--2018-01-13-">3.0.0 (2018-01-13)</h2><ul>
<li>feat: 3.0 API now is fixed. reday to publish (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/32a7b6d">32a7b6d</a>)</li>
<li>feat: API chanes again ! get current frame (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/cc76f02">cc76f02</a>)</li>
<li>feat: config (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/62118e1">62118e1</a>)</li>
<li>feat: config validater (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/cc587b2">cc587b2</a>)</li>
<li>feat: delete config validate function (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0234132">0234132</a>)</li>
<li>feat: elementMgr codes, modify API (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/e6433e3">e6433e3</a>)</li>
<li>feat: elementMgr functionally done (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/aa09c5d">aa09c5d</a>)</li>
<li>feat: FINALLY USEABLE (basically) (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7c121a2">7c121a2</a>)</li>
<li>feat: finish config validater (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/67a0558">67a0558</a>)</li>
<li>feat: fix webpack PublicPath prob. (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/093ee10">093ee10</a>)</li>
<li>feat: http(s) protocol supports for model&apos;s json&apos;s textures (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/d9b854a">d9b854a</a>)</li>
<li>feat: import lodash (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/be5531d">be5531d</a>)</li>
<li>feat: marked unfinished files, rebuild file structure, config works (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/62555a9">62555a9</a>)</li>
<li>feat: modified live2d core js (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/d3c7ab5">d3c7ab5</a>)</li>
<li>feat: TEST Create DOM use js (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/1a8db01">1a8db01</a>)</li>
<li>feat: update source code (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/28d350b">28d350b</a>)</li>
<li>feat: use ~ to mark version (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/4f0e865">4f0e865</a>)</li>
<li>feat(API): typo (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/b342953">b342953</a>)</li>
<li>feat(config): new config (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/5f13a2b">5f13a2b</a>)</li>
<li>feat(Webpack): lazy load and chunks (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/ccbe0d0">ccbe0d0</a>)</li>
<li>feat(Webpack): updated webpack config (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/260cbad">260cbad</a>)</li>
<li>chore: add comments (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/24b43e3">24b43e3</a>)</li>
<li>chore: new build version (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/c698c90">c698c90</a>)</li>
<li>chore: new build version (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7216003">7216003</a>)</li>
<li>docs: add ESDoc (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/9a67891">9a67891</a>)</li>
<li>docs: added demo and doc (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/5d4cddc">5d4cddc</a>)</li>
<li>docs: fix bugs, update (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/14d0730">14d0730</a>)</li>
<li>docs: new doc build logic (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/a7f1d54">a7f1d54</a>)</li>
<li>docs: Update API varible types (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/f3ab76b">f3ab76b</a>)</li>
<li>docs: update CHANGELOG (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/abf0618">abf0618</a>)</li>
<li>docs: update CHANGELOG (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/89765f5">89765f5</a>)</li>
<li>docs: update docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/0ec0dec">0ec0dec</a>)</li>
<li>docs: update docs (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/3955611">3955611</a>)</li>
<li>docs(LICENSE): combine LICENSE (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/6be306f">6be306f</a>)</li>
<li>feat: (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/8c668b1">8c668b1</a>)</li>
<li>Initial commit (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/cc61b39">cc61b39</a>)</li>
<li>The Real Initial Commit (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/23ba71c">23ba71c</a>)</li>
<li>build: new doc build method (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/6854707">6854707</a>)</li>
<li>fix: old dependencies (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/7a2f272">7a2f272</a>)</li>
<li>fix(webpack): fix webpack publicPath issue (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/a8a630e">a8a630e</a>)</li>
<li>style: fix indent (<a href="https://github.com/xiazeyu/live2d-widget.js/commit/cb6f7d9">cb6f7d9</a>)</li>
</ul>
<h3 id="breaking-change">BREAKING CHANGE</h3><ul>
<li>change userConfig.display.AA to userConfig.display.antialias</li>
<li>change userConfig.display.widght to userConfig.display.width</li>
<li>Please use L2DWidget.init() and L2DWidget.captureFrame() instead of initL2DWidget()</li>
</ul>
</div>
</div>

<footer class="footer">
  Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>

<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
